-
Notifications
You must be signed in to change notification settings - Fork 11
🤖 docs: improve design and organization #461
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add mdbook, mdbook-mermaid, and mdbook-linkcheck to the nix development shell for building documentation locally. These tools are required by the docs build scripts (scripts/docs.sh and scripts/docs_build.sh).
Change `mdbook serve` to bind to 0.0.0.0 instead of localhost, allowing remote access to the docs server. This is useful for development environments like remote servers or containers.
Improve blockquote design: - Increase padding and add border-radius for better visual appeal - Add subtle box-shadow for depth - Support GitHub-style alerts (Note, Tip, Important, Warning, Caution) - Color-coded left borders for each alert type: - Note: blue - Tip: green - Important: purple - Warning: orange - Caution: red - Better paragraph spacing within blockquotes Usage: > **Note**: This is a note > **Warning**: This is a warning > **Tip**: This is a tip
Set all border-radius values to 0 for a sharper, more consistent visual style across all elements (blockquotes, code blocks, tables, details, images, inputs, etc.).
Remove full border and box-shadow from blockquotes, keeping only the left border accent. This eliminates the diagonal corner artifacts that occurred when mixing thin borders with thick left borders at 0 radius. Changes: - Remove 1px full border (only keep 3px left border) - Remove box-shadow - Increase background opacity slightly for better contrast - Cleaner look that works well with sharp corners
Bring back border-radius to fix diagonal border artifacts while maintaining a cohesive look throughout the UI. Changes: - Set consistent border-radius values (lg: 8px, md: 6px, sm: 4px, xs: 3px) - Apply to blockquotes (fixes diagonal corner issue) - Apply to inline code (xs: 3px) - Apply to code blocks (md: 6px) - Already applied to: tables, details, mermaid, images, kbd, search All UI elements now have matching rounded corners for a polished, consistent appearance.
Tables weren't showing rounded corners because `border-collapse: collapse` prevents border-radius from working. Changes: - Use `border-collapse: separate` with `border-spacing: 0` - Add outer border to table element - Remove duplicate borders between cells (only right/bottom on cells) - Explicitly set border-radius on corner cells (first/last th/td) - Add `overflow: hidden` to enforce rounded corners Tables now have properly rounded corners matching other UI elements.
Move local workspace details from workspaces.md into new local.md page, making it subordinate to Workspaces (matching SSH structure). Changes: - Create docs/local.md with local workspace details (worktrees, reviewing, filesystem layout) - Simplify docs/workspaces.md to high-level overview with links to specific workspace types - Update SUMMARY.md to include Local as sub-page under Workspaces Structure now: - Workspaces (overview) - Local (git worktree details) - SSH (remote workspace details) - Forking - Init Hooks This provides better organization and makes it easier to find workspace-type-specific information.
Move 'Reviewing Code' and 'Reviewing Functionality' sections from local.md to workspaces.md since they apply to both local and SSH workspaces. Changes: - Add reviewing sections to workspaces.md after 'Key Concepts' - Remove reviewing sections from local.md (now focuses on worktree mechanics and filesystem layout) - Add note in 'Reviewing Functionality' about detached HEAD being specific to local workspaces This reduces duplication and puts shared concepts in the parent page where they're easier to find.
CI Status UpdateThe integration tests are timing out at exactly 10 minutes on multiple retry attempts. This appears to be a CI infrastructure issue rather than a problem with the code changes. Evidence:
Recommendation: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Improves documentation visual design and reorganizes workspace documentation for better clarity.
Visual Design Improvements
Blockquotes
Border-Radius
border-collapse: collapsetoseparate)Server Configuration
Documentation Organization
Workspace Pages
docs/local.mdfor local workspace detailsdocs/workspaces.mdto high-level overviewNew structure:
Development Setup
Generated with
cmux